This is an extension library that only has a peer dependency to piral-core
. What piral-search
brings to the table is a set of API extensions that can be used with piral
or piral-core
to bring enhanced search capabilities to pilets via your Piral instance. By default, these extensions are not integrated in piral
, so you'd need to add them to your Piral instance.
Documentation
For details on the provided API check out the documentation at the Piral website or on GitHub.
Setup and Bootstrapping
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import createSearchApi
from the piral-search
package.
import { createSearchApi } from 'piral-search';
The integration looks like:
const instance = createInstance({
extendApi: [createSearchApi()],
});
Via the options the initially displayed results
can be defined. The current query
can also be set.
For example:
const instance = createInstance({
extendApi: [createSearchApi({
query: '!help',
results: [
<div>
Help was found!
</div>,
],
})],
});
License
Piral is released using the MIT license. For more information see the license file.